Skip to content

docs: document --drivers flag and compute driver auto-detection#1136

Closed
mesutoezdil wants to merge 1 commit intoNVIDIA:mainfrom
mesutoezdil:docs/document-compute-driver-auto-detection
Closed

docs: document --drivers flag and compute driver auto-detection#1136
mesutoezdil wants to merge 1 commit intoNVIDIA:mainfrom
mesutoezdil:docs/document-compute-driver-auto-detection

Conversation

@mesutoezdil
Copy link
Copy Markdown
Contributor

@mesutoezdil mesutoezdil commented May 2, 2026

  • Add --drivers row to the Advanced Start Options table in manage-gateways.mdx
  • Documents the auto-detection priority order (Kubernetes → Podman → Docker) and the fact that vm must be set explicitly

Related Issue: Follows up on #1088, which added auto-detection but left the architecture docs checkbox unchecked.

File Change
docs/sandboxes/manage-gateways.mdx Add one table row documenting --drivers and auto-detection behaviour

Testing

  • Docs only — no code changes
  • Verified flag name and detection priority against crates/openshell-server/src/cli.rs (line 67–82) and crates/openshell-core/src/config.rs

Checklist

  • Follows the docs style guide (active voice, no filler)
  • Conventional commit message used
  • DCO sign-off included

The gateway auto-detects the compute driver (Kubernetes → Podman →
Docker) when --drivers is not set. The VM driver requires explicit
configuration. Added a table row to the Advanced Start Options section
to document this behavior.

Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@mesutoezdil mesutoezdil requested a review from a team as a code owner May 2, 2026 11:21
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 2, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@johntmyers
Copy link
Copy Markdown
Collaborator

We are planning a docs upgrade for drivers that will be more comprehensive.

@johntmyers johntmyers closed this May 2, 2026
@mesutoezdil
Copy link
Copy Markdown
Contributor Author

@johntmyers thx! Good to know. I'd love to get more involved with openshell, feel free to contact me if there's anything I can contribute.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants